SpringCloud 入门笔记(六)Zuul服务网关

概述

Zuul是Netflix开源的微服务网关,SpringCloud进行了集成,能够非常方便地与Eureka、Ribbon等组件集成。

本篇拟采用Zuul搭建一个简单的微服务网关。

构建Zuul服务网关

构建gateway项目

因为我们要将gateway注册到服务中心,因此构建项目时,选择Eureka Client和Zuul依赖,如下所示:

创建成功后,pom.xml会包含如下两个选择的依赖:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-zuul</artifactId>
</dependency>

<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>

<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>

编写application.yml配置文件,如下:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
server:
port: 8020
spring:
application:
name: gateway
eureka:
client:
service-url:
defaultZone: http://admin:admin123@127.0.0.1:8000/eureka/
zuul:
routes:
user-ms:
path: /user/**
strip-prefix: false
role-ms:
path: /role/**
strip-prefix: false

上面zuul.routes节点的配置中,星号代表通配符,表示将 /user/ 开头的请求路由至user-ms微服务,将 /role/ 开头的请求路由至role-ms微服务。

路由配置示例

Zuul支持多种方式的路由配置,如下所示(参考自:《Spring Cloud与Docker微服务架构实战》):

  1. 定义指定服务的访问路径
1
2
3
4
zuul:
routes:
user-ms: /u/**
role-ms: /r/**
  1. 忽略指定的服务
1
2
zuul:
ignored-services: serviceA,ServiceB
  1. 忽略所有服务
1
2
zuul:
ignored-services: '*'
  1. 指定服务的serviceId和路径
1
2
3
4
5
zuul:
routes:
user: # 服务别名,可任意起名
service-id: user-ms
path: /u/**
  1. 指定url和路径
1
2
3
4
5
zuul:
routes:
github:
path: /github/**
url: https://github.com/GreedyStar
  1. 路由前缀
1
2
3
4
5
zuul:
routes:
user-ms:
path: /user/**
strip-prefix: false

访问Zuul的 /user/1 路径,请求会转发至user-ms的/user/1

这是很常用的一种方式,在user-ms的Controller中,我们将所有请求映射至/user/路径下,在不配置strip-prefix时,我们需要请求user-ms/user/user/list 才能正确请求到user-ms的接口。

测试

我们可以通过gateway来访问到指定的微服务,本篇中建立的路由规则为:

Path MicroService
/user/** user-ms localhost:8800
/role/** role-ms localhost:8801

结果如下:

源码地址:https://github.com/GreedyStar/yogurt

最后的最后,安利一下自己写的一个Java代码生成工具,能够方便的生成Spring、SpringMVC、Mybatis架构下的Java代码,希望能对大家有所帮助,地址:Java代码生成器:Generator